api/priceSetsByName/{name} (Get)

Get	api/priceSetsByName/{name}

In This Topic

Resource Path: /sites/{company-id}/api/priceSetsByName/{name}

Uri: https://secure.ontime360.com/sites/{company-id}/api/priceSetsByName/{name}

Description

Retrieves a single PriceSet object assigned to a given name.

Parameters

Name	Description	Data Type
name	The name of a PriceSet as a String.	string

200 Response

The response body is of type PriceSet.

Returns a comprehensive PriceSet object.

PriceSet

Represents a comprehensive PriceSet record within the OnTime API.

PriceModifiers : Array[]

The collection of unique Guid identifiers referencing all PriceModifier records associated with this PriceSet.

ID : string

The unique identifier for this PriceSet record.

InternalName : string

The internal name of this PriceSet.

ServiceLevel : string

The public display name of this PriceSet, represented as the service level.

DispatcherInstructions : string

The instructions given to a dispatcher (i.e. a User) regarding this PriceSet.

CustomerInstructions : string

The instructions given to a Customer regarding this PriceSet.

PercentCommissionable : number

The percentage-based value used to determine the commissionable amount for this PriceSet.

IsDisplayedOnCustomerWebPortal : boolean

The visibility of this PriceSet within the Customer Web Portal.

Fault Responses

Fault	Description
400	Request was improperly formatted, contained invalid data, or contained incorrect values. See response body for more information.
401	Authorization key is invalid or no longer exists.
403	Authorization key does not have permission to perform this action, or does not have permission to access the requested data. See response body for more information.